DOC-12561 Continuous backup PITR#4138
Open
ggray-cb wants to merge 30 commits into
Open
Conversation
* Added minitor continuous backup. * Updated metrics. * Finished draft of manage continuous backup.
…he install section.
There was a problem hiding this comment.
Pull request overview
Adds Couchbase Server 8.1 documentation and reference updates for the new Continuous Backup + Point-in-Time Recovery (PITR) capabilities, including new Learn/Manage pages, navigation entries, and supporting operational reference updates (ports/processes/metrics metadata).
Changes:
- Introduces new Learn + Manage documentation for continuous backup and PITR, plus example command/log snippets.
- Updates site navigation and related “new features”/cross-reference pages to surface continuous backup.
- Extends metrics metadata and operational reference docs (install ports + server processes) to reflect new/updated functionality.
Reviewed changes
Copilot reviewed 19 out of 20 changed files in this pull request and generated 23 comments.
Show a summary per file
| File | Description |
|---|---|
| preview/DOC-12561_Continuous_backup_PITR.yml | Adds a preview build config enabling the backup content source for the DOC-12561 preview. |
| modules/ROOT/nav.adoc | Adds nav entries for the new continuous backup/PITR learn + manage pages. |
| modules/metrics-reference/attachments/n1ql_metrics_metadata.json | Adds/adjusts SQL++ (N1QL) metrics metadata entries. |
| modules/metrics-reference/attachments/kv_metrics_metadata.json | Adds/adjusts KV metrics metadata (including continuous backup/magma/fusion-related metrics). |
| modules/metrics-reference/attachments/index_metrics_metadata.json | Adds new index metrics metadata for vector-related index counts. |
| modules/metrics-reference/attachments/goxdcr_metrics_metadata.json | Updates XDCR metrics help/notes and adjusts a metric type/version entry. |
| modules/metrics-reference/attachments/fts_metrics_metadata.json | Adds new FTS metrics metadata for vector indexes in CPU/GPU memory. |
| modules/metrics-reference/attachments/cm_metrics_metadata.json | Adds a new CM telemetry metric metadata entry. |
| modules/manage/pages/manage-backup-and-restore/monitor-continuous-backup.adoc | New “monitor continuous backup” operational doc page. |
| modules/manage/pages/manage-backup-and-restore/manage-pitr.adoc | New PITR management doc page. |
| modules/manage/pages/manage-backup-and-restore/manage-continuous-backup.adoc | New “configure/manage continuous backup” doc page. |
| modules/manage/examples/continuous-backup.sh | Adds example cbcontbk CLI snippets referenced by the Manage docs. |
| modules/manage/examples/continuous-backup.log | Adds example output referenced by the Manage docs. |
| modules/learn/pages/services-and-indexes/services/continuous-backup.adoc | New Learn overview page describing continuous backup + PITR concepts. |
| modules/learn/pages/services-and-indexes/services/backup-service.adoc | Adds a section linking Backup Service to continuous backup/PITR. |
| modules/learn/pages/data/change-history.adoc | Adds guidance tying change history requirements to continuous backup usage. |
| modules/learn/pages/clusters-and-availability/hard-failover.adoc | Adds a caution about unsafe failover behavior when continuous backup is enabled. |
| modules/introduction/partials/new-features-81.adoc | Adds 8.1 release notes bullets for continuous backup + PITR. |
| modules/install/pages/server-processes.adoc | Documents the cbcontbk process and normalizes path formatting in the process table. |
| modules/install/pages/install-ports.adoc | Adds port 9125 and documents the cbcontbk port usage. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
incomplete sentences.
ggray-cb
requested review from
TimLFletcher,
matthallcb,
owend74 and
shivaniguptasf
July 2, 2026 15:16
matthallcb
reviewed
Jul 3, 2026
|
|
||
| The following example enables continuous backup for `travel-sample` bucket. | ||
| It sets the backup interval to 10 minutes. | ||
| The backup location is an NFS share mounted on each not at the path `/shared.continuous-backup`. |
There was a problem hiding this comment.
I'm not sure what this sentence is saying
| * `--continuous-backup-location`: The location where the backup service will store the continuous backup data. | ||
| This value must a string containing either an absolute path to an NFS mount point mounted on every node or a cloud storage URI. | ||
| * `--continuous-backup-cloud-storage-cred-id`: If you set `--continuous-backup-location` to a cloud storage URI, set this to the name of a credential in the Couchbase Server credential store. | ||
| The Backup Service uses this credential to authenticate with the cloud provider. |
Comment on lines
+56
to
+60
| * To prevent consistency issues, stop continuous backup on the bucket you're restoring. | ||
| You must stop continuous backup even if you're not restoring to the original bucket. | ||
| Once the PITR finishes, you can restart continuous backup. | ||
| See xref:manage:manage-backup-and-restore/manage-continuous-backup.adoc#stop-continuous-backup[Stop Continuous Backup] to learn how to stop continuous backup for a bucket. | ||
|
|
There was a problem hiding this comment.
Note for myself: I'm not sure if this is necessary, I need to check
matthallcb
reviewed
Jul 22, 2026
| * Verify that all of the system clocks in your cluster are synchronized. | ||
| See xref:install:synchronize-clocks-using-ntp.adoc[] for more information. | ||
|
|
||
| * You must configure scheduled periodic backups using either the Backup Service or `cbbackupmgr`. |
There was a problem hiding this comment.
Can we mention that it takes a backup interval before continuous backup uploads any data. Because your cbbackupmgr backups and continuous backups must overlap, that means you need to wait a backup interval, then do a cbbackupmgr backup before continuous is ready to use
Contributor
Author
There was a problem hiding this comment.
This seems like a better fit for the PITR requirements, so I'll spell it out there. I'll add a mention about the backup requirement both in the continuous backup requirements and at the end of the enabling process and point them to the PITR document for the details.
Question: does this have to be a full backup, or is it enough to have an incremental backup taken after continuous backup starts saving data?
There was a problem hiding this comment.
Thanks, agreed on it being better in requirements. In answer to your question, an incremental taken afterwards works just fine.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds documentation for Continuous backup and point-in-time recovery,
The links in the following changes led to the preview site. You will need the Docs Team credentials on Confluence.
New pages added:
Existing pages updated:
cbcontbkPlease review by July 12th.